Autres exemples

Ces exemples aideront les utilisateurs à consolider leur compréhension des requêtes API vers le carrefour de données. Consultez les autres guides d’API avant de poursuivre.

## Exemple 1 — Indicateur de chômage

Suivez les étapes ci-dessous pour envoyer une requête API concernant le taux de chômage en Colombie-Britannique en mars 2018.

Indicateur

Le taux de chômage a un identifiant dans le Carrefour de données de 6, par conséquent :

indicator=6

Horodatage

Sélectionnez la date de mars 2018 en indiquant que le jour du mois est arbitraire, car les données sont mensuelles :

start=20180306&end=20180306

Géographie

Étant donné que la géographie par défaut est le Canada, et non la Colombie-Britannique, la requête API doit préciser ce point. Si une requête API était effectuée sans autre étape, le taux de chômage pour le Canada à la date donnée serait renvoyé.

Demander que le niveau d’agrégation retourné soit au niveau provincial et territorial en ajoutant un autre paramètre au point de terminaison et à la chaîne de requête :

geo=provinces_territories

Maintenant que l’agrégation des provinces et des territoires a été précisée, une requête dans cet état actuel renverrait des enregistrements pour chaque province et territoire. Un filtre est nécessaire pour obtenir uniquement la Colombie-Britannique.

Dans le corps de la requête API, ajoutez le filtre suivant :

{"province_territory":["BC"]}

Aperçu de la requête et de la réponse

En combinant les chaînes de requête et les filtres comme ci-dessus, la requête API pour cet exemple ressemblera à ce qui suit au format CURL :

curl --location --request POST 'https://lmic-datahub-prod-gw-d6ow9n6v.uc.gateway.dev/lmi?indicator=6&geo=provinces_territories&start=20180306&end=20180306' \
--header 'x-api-key: API_KEY_HERE' \
--header 'Content-Type: application/json' \
--data-raw '{"province_territory":["BC"]}'

' La réponse API :

{
    "data": [
        {
            "source": "LFS-14100017; LFS-14100287",
            "as_of_date": "2022-03-01",
            "ref_date": "2018-03-01",
            "data_frequency": "monthly",
            "country": "Canada",
            "provinces_territories": "BC",
            "cma_en": null,
            "economic_regions_en": null,
            "sex_en": "Both sexes",
            "age_en": "15 years and over",
            "noc_level": null,
            "noc_code": null,
            "noc_title_en": null,
            "naics_level": null,
            "naics_code": null,
            "naics_title_en": null,
            "adjustment_en": "unadjusted",
            "indicator_name_en": "Unemployment rate",
            "indicator_value": 0.048
        }
    ],
    "meta": {
        "current_page": 1,
        "total_pages": 1,
        "per_page": 1000,
        "total_rows": 1
    }
}

La valeur de l’indicateur souligne que le taux de chômage des hommes en Colombie-Britannique en 2018-03-06 est de 4,8 %. Veuillez noter que l’indicateur du taux de chômage est rapporté mensuellement, ce qui signifie que toute date sélectionnée au cours du mois de mars 2018 renverrait la même valeur d’indicateur.

## Exemple 2 — Offres d’emploi

Suivez les étapes ci-dessous pour envoyer une demande de dénombrement des offres d’emploi dans la région du recensement de Montréal en 2021 avec la CNP « Professions libérales en sciences naturelles et appliquées ».

Indicateur

L’indicateur du nombre d’offres d’emploi a un identifiant dans le Carrefour de données de 14, par conséquent :

indicator=14

Horodatage

Pour sélectionner les dates correspondant à 2022, les paramètres Start (Début) et End (Fin) sont utilisés avec le format YYYYMMDD (AAAAMMJJ), donnant le point de terminaison :

start=20210101&end=20211231

Géographie

Filtre pour la région de recensement de Montréal.

Premièrement, demandez que le niveau d’agrégation retourné soit au niveau de la région de recensement en ajoutant un paramètre supplémentaire au point de terminaison et à la chaîne de requête :

geo=census_division

Deuxièmement, dans le corps de la requête API, ajoutez le filtre suivant pour obtenir uniquement la région de recensement de Montréal :

{"cma":["Montréal"]}

Fréquence

Les indicateurs d’offres d'emploi ont une agrégation mensuelle par défaut. Par conséquent, la requête API dans son état ci-dessus renverrait 12 enregistrements, un pour chaque mois en 2021. Utilisez la chaîne de requête suivante pour agréger la réponse API annuellement :

freq=annual

NOC (CNP)

« Professions libérales en sciences naturelles et appliquées » a un identifiant CNP de 2. Modifiez le corps JSON pour filtrer uniquement la CNP 2 :

"noc": "2"

Aperçu de la requête et de la réponse

En combinant les chaînes de requête et les filtres comme ci-dessus, la requête API pour cet exemple ressemblera à ce qui suit au format CURL :

curl --location --request POST 'https://lmic-datahub-prod-gw-d6ow9n6v.uc.gateway.dev/lmi?indicator=14&geo=census_division&start=20210101&end=20211231&freq=annual&noc_level=1' \
--header 'x-api-key: API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{"census_division":["Montréal"],"noc": "2"}

La réponse API :

    {
        "data": [
            {
                "source": "Vicinity Jobs",
                "ref_date": "2021-12-31",
                "data_frequency": "annual",
                "noc_code": "2",
                "noc_level": 1,
                "noc_title_en": "Natural and applied sciences and related occupations",
                "country": "Canada",
                "provinces_territories": "QC",
                "economic_regions_en": "Montréal",
                "census_division": "Montréal",
                "location": null,
                "indicator_name_en": "Job postings count",
                "indicator_value": 14545
            }
        ],
        "meta": {
            "current_page": 1,
            "total_pages": 1,
            "per_page": 1000,
            "total_rows": 1
        }
    }

## Exemple 3 — Exigences de travail

Suivez les étapes ci-dessous pour envoyer une requête de partage des exigences de travail pour les «auditeurs financiers et les comptables» dans la région économique de Toronto en 2021.

Indicateur

L’indicateur de partage des exigences de travail a un identifiant dans le Carrefour de données de 18, donc :

indicator=18

Fréquence

Les indicateurs d’offres d'emploi ont une agrégation mensuelle par défaut. Par conséquent, la requête API dans son état ci-dessus renverrait 12 enregistrements, un pour chaque mois de 2021. Utilisez la chaîne de requête suivante pour agréger la réponse API annuellement :

freq=annual

Horodatage

La sélection de dates pour cet indicateur peut être source d'erreurs. La source de données, Vicinity Jobs, fournit des données mensuelles, et l’API retournera des données agrégées par mois par défaut. Dans ce cas, lorsqu’une année est requise, l’utilisateur doit inclure le mois de janvier 2021 et décembre 2021 dans les paramètres de début et de fin, respectivement. Si une date comprise dans ces mois est demandée, l’API retournera une réponse vide, car moins d’une année de données est demandée. Par conséquent, la requête de la chaîne 2021 pourrait ressembler à ceci :

start=20210101&end=20211201

Géographie

Filtre pour la région économique « Toronto ».

Tout d’abord, demander que le niveau d’agrégation retourné soit au niveau d’une région économique en ajoutant un autre paramètre au point de terminaison et à la chaîne de requête :

geo=economic_regions

Deuxièmement, dans le corps de la requête API, ajoutez le filtre suivant pour n'obtenir que la région économique de « Toronto » :

{"economic_region":["Toronto"]}

NOC (CNP)

Tout d’abord, précisez la chaîne de requête :

noc_level=4

En sélectionnant le niveau 4 de la CNP, le filtre peut préciser la CNP détaillée pour les « Auditeurs financiers et comptables ».

Ensuite, dans le corps de la requête API, ajoutez le filtre suivant pour n'obtenir que la CNP de 1111 :

"noc":["1111"]

Aperçu de la requête et de la réponse

En combinant les chaînes de requête et les filtres comme ci-dessus, la requête API pour cet exemple ressemblera à ce qui suit au format CURL :

curl --location --request POST 'https://lmic-datahub-prod-gw-d6ow9n6v.uc.gateway.dev/lmi?indicator=18&geo=economic_regions&start=20200101&end=20201201&freq=annual&noc_level=4' \
--header 'x-api-key: API_KEY_HERE' \
--header 'Content-Type: application/json' \
--data-raw '{"noc":["1111"],"economic_region":["Toronto"]}

La réponse API (premier en-tête uniquement) :

{
    "data": [
        {
            "source": "Vicinity Jobs",
            "ref_date": "2020-12-31",
            "data_frequency": "annual",
            "group_en": "Knowledge",
            "work_requirement_en": "Accounting",
            "education_level_en": "Occupations usually require university education",
            "noc_code": "1111",
            "noc_level": 4,
            "noc_title_en": "Financial auditors and accountants",
            "country": "Canada",
            "provinces_territories": "ON",
            "economic_regions_en": "Toronto",
            "census_division": null,
            "location": null,
            "indicator_name_en": "Share of job postings",
            "indicator_value": 0.687
        },

Autres exemples

Indicateur​

Horodatage​

Géographie​

Aperçu de la requête et de la réponse​

Indicateur​

Horodatage​

Géographie​

Fréquence​

NOC (CNP)​

Aperçu de la requête et de la réponse​

Indicateur​

Fréquence​

Horodatage​

Géographie​

NOC (CNP)​

Aperçu de la requête et de la réponse​

Indicateur

Horodatage

Géographie

Aperçu de la requête et de la réponse

Indicateur

Horodatage

Géographie

Fréquence

NOC (CNP)

Aperçu de la requête et de la réponse

Indicateur

Fréquence

Horodatage

Géographie

NOC (CNP)

Aperçu de la requête et de la réponse